Routines (alphabetical) > Routines: H > HDF5 Routines > H5T_ENUM_SET_DATA

H5T_ENUM_SET_DATA

The H5T_ENUM_SET_DATA procedure sets all the name/value pairs on an enumeration datatype object.

This routine is written in the IDL language. Its source code can be found in the file h5t_enum_set_data.pro in the lib subdirectory of the IDL distribution.

Syntax

H5T_ENUM_SET_DATA, Datatype_id, Data, Values

Arguments

Datatype_id

A long integer containing the identifier of the enumeration datatype.

Data

A string array or array of named structures:

If Data is a string array, it contains the names of the members of the enumeration datatype, and the Values argument is required.
If Data is an array of named structures, the Values argument is ignored. The structures that make up Data must be of type IDL_H5_ENUM, which has the following signature:

{IDL_H5_ENUM, NAME:'', VALUE:0}

Values

An integer array containing the values of the members of the enumeration datatype. The Values array must have the same number of elements as the string array specified by Data. This argument is ignored if Data is an array of structures.

Keywords

None

Version History

6.3	Introduced